Fix building and deploying documentaton #546
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
susnux
added
bug
susnux
force-pushed
the
fix/documentaton
branch
2 times, most recently
from
b5451d4
to
11650a8
Compare
skjnldsv
requested changes
Jan 6, 2023
.github/workflows/deploy.yml
Outdated
Comment on lines
1
to
24
| name: Deploy documentation | ||
| on: | ||
| push: | ||
| branches: | ||
| - master | ||
| permissions: | ||
| contents: write | ||
| jobs: | ||
| build-and-deploy: | ||
| concurrency: ci-${{ github.ref }} | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout 🛎️ | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: Install and Build 🔧 | ||
| run: | | ||
| npm ci | ||
| npm run build:doc | ||
|
|
||
| - name: Deploy 🚀 | ||
| uses: JamesIves/github-pages-deploy-action@v4 | ||
| with: | ||
| folder: dist/doc |
There was a problem hiding this comment.
Suggested change
| name: Deploy documentation | |
| on: | |
| push: | |
| branches: | |
| - master | |
| permissions: | |
| contents: write | |
| jobs: | |
| build-and-deploy: | |
| concurrency: ci-${{ github.ref }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout 🛎️ | |
| uses: actions/checkout@v3 | |
| - name: Install and Build 🔧 | |
| run: | | |
| npm ci | |
| npm run build:doc | |
| - name: Deploy 🚀 | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| folder: dist/doc | |
| name: Deploy documentation | |
| on: | |
| push: | |
| branches: | |
| - master | |
| permissions: | |
| contents: write | |
| jobs: | |
| build-and-deploy: | |
| concurrency: ci-${{ github.ref }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Read package.json node and npm engines version | |
| uses: skjnldsv/read-package-engines-version-actions@v2 | |
| id: versions | |
| with: | |
| fallbackNode: '^14' | |
| fallbackNpm: '^7' | |
| - name: Set up node ${{ steps.versions.outputs.nodeVersion }} | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: ${{ steps.versions.outputs.nodeVersion }} | |
| - name: Set up npm ${{ steps.versions.outputs.npmVersion }} | |
| run: npm i -g npm@"${{ steps.versions.outputs.npmVersion }}" | |
| - name: Install dependencies & build | |
| run: | | |
| npm ci | |
| npm run build:doc --if-present | |
| - name: Deploy | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| branch: gh-pages | |
| folder: dist/doc |
There was a problem hiding this comment.
branch: gh-pages is not needed as that is the default, but I think adding it does not hurt
|
Also, please rename the workflow to a more straightforward name like |
* Add `typedoc.json` instead of command-line flags, as the interface changed * Add plugin to document not exported objects (needed for the gettext module) * Add some module description for index and gettext Signed-off-by: Ferdinand Thiessen <rpm@fthiessen.de>
Signed-off-by: Ferdinand Thiessen <rpm@fthiessen.de>
susnux
force-pushed
the
fix/documentaton
branch
from
11650a8
to
2b7c218
Compare
skjnldsv
approved these changes
Jan 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current
build:docscript does not work, astypedochas changed its interface, this is fixed by the first commit.Also the documentation is not deployed anymore since travis was removed, this is fixed by the second commit which uses a github action for documentation deployment.